Skip to content

docs: repository governance, license, and backlog↔issue sync - #55

Merged
yashranaway merged 1 commit into
mainfrom
t3code/repo-hygiene
Aug 5, 2026
Merged

docs: repository governance, license, and backlog↔issue sync#55
yashranaway merged 1 commit into
mainfrom
t3code/repo-hygiene

Conversation

@yashranaway

Copy link
Copy Markdown
Collaborator

Brings the repository up to the standard the product itself claims. No shipped behaviour changes.

Legal — the one that actually mattered

The repository was public with no LICENSE file. It is a fork of antiwork/chromeless, which is MIT, so two things were wrong: redistribution rights here were undefined, and the upstream copyright notice was not being carried as MIT requires. Added LICENSE (MIT) preserving Copyright (c) 2026 Antiwork, Inc. alongside the LockInTime notice.

If the intended license is anything other than MIT, say so — but note the upstream notice has to stay regardless.

Governance

File Why
SECURITY.md Private reporting route, plus the boundary table a report is judged against (no arbitrary execution, navigation, downloads, control plane, artifacts, secrets, untrusted content, sandbox) and the limitations that are not vulnerabilities
CONTRIBUTING.md Setup per platform, the bar for a PR, style, and the rule that contract changes need an architecture-decision entry first
CODE_OF_CONDUCT.md Contributor Covenant 2.1; enforcement routed through private advisories
CHANGELOG.md Keep a Changelog format, with an Unreleased section — context pruning, capture formats, docs, and CI have all landed since v1.0.2

Tracker plumbing

  • Issue forms for bugs and feature proposals. The feature form states the permanent non-goals up front (arbitrary JS, TCP listener, downloads, desktop automation) so those proposals do not get written in the first place.
  • config.yml routes security reports to private advisories rather than public issues.
  • PR template whose checklist is the host-enforced contract list.
  • CODEOWNERS on the security-critical sources (Protocol, Transport, Artifacts, AgentRuntime, both hosts) and the roadmap docs.
  • Dependabot for the web app (grouped react/next/tailwind/types), root tooling, Actions, and the Linux image. The Swift package is deliberately excluded — zero third-party dependencies is a documented feature.

Backlog ↔ issues

All 42 open backlog items are now GitHub issues (#12#53), plus a tracking issue for the ten §G ideas (#54). Each issue body is extracted from the backlog text itself, so the two cannot drift, and each carries type/area/priority labels and the milestone for its roadmap phase. This PR adds the reverse links inline in the backlog file, and explains the workflow in AGENTS.md and README.md.

Correction included: §F1 claimed no deploy pipeline exists. It does — the site is live at headless-web-pi.vercel.app via Vercel's GitHub integration. Rewrote the item to describe what is actually missing: repo-visible config, deploy docs, and a real domain.

Also configured outside this PR

Labels (type/area/priority/status taxonomy), six milestones matching the roadmap phases, repo description and topics, delete_branch_on_merge, and branch protection on main requiring the six CI checks plus one review.

A GitHub project board could not be created — the CLI token lacks the project scope. Milestones cover the same ground; add the board manually if you want a kanban view.

Brings the repository up to the standard the product claims. Nothing here
changes shipped behaviour.

Governance and legal:

- LICENSE — MIT, preserving the upstream Antiwork copyright from the
  chromeless project this was forked from. The repository was public with no
  license file at all, which left redistribution rights undefined and did not
  satisfy the upstream notice requirement.
- SECURITY.md — private reporting route plus the boundary table a report is
  measured against, and the documented limitations that are not
  vulnerabilities.
- CODE_OF_CONDUCT.md — Contributor Covenant 2.1.
- CONTRIBUTING.md — setup, the bar for a PR, style, and the rule that
  contract changes need an architecture-decision entry first.

Tracker plumbing:

- Issue forms for bugs and feature proposals, a config that routes security
  reports to private advisories, and a pull-request template whose checklist
  is the host-enforced contract list.
- CODEOWNERS covering the security-critical sources and the roadmap docs.
- Dependabot for the web app, root tooling, Actions, and the Linux image. The
  Swift package has no third-party dependencies by design, so it is excluded.
- CHANGELOG.md, including an Unreleased section — context pruning, capture
  formats, the docs set, and CI have all landed since v1.0.2.

Backlog sync:

- All 42 open backlog items now link to their GitHub issue inline, and §G
  links to its tracking issue. AGENTS.md and README explain how to pick work
  up from either surface and to keep both in sync.
- Corrected §F1: the site is in fact deployed on Vercel. What is missing is
  repo-visible config, deploy documentation, and a real domain.
@yashranaway
yashranaway requested a review from SarthakWade August 5, 2026 19:15
@yashranaway
yashranaway merged commit 9627a59 into main Aug 5, 2026
7 checks passed
@yashranaway
yashranaway deleted the t3code/repo-hygiene branch August 5, 2026 19:18
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant